<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.grid</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;grid
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.grid-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="py2ecotect.doc.grid-module.html">Module py2ecotect.doc.grid</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">   1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package py2ecotect=py2ecotect-module.html"><a title="py2ecotect" class="py-name" href="#" onclick="return doclink('link-0', 'py2ecotect', 'link-0');">py2ecotect</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">p2e</tt> </tt>
<a name="L2"></a><tt class="py-lineno">   2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno">   3</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L4"></a><tt class="py-lineno">   4</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Functions</tt> </tt>
<a name="L5"></a><tt class="py-lineno">   5</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="export_data"></a><div id="export_data-def"><a name="L6"></a><tt class="py-lineno">   6</tt> <a class="py-toggle" href="#" id="export_data-toggle" onclick="return toggle('export_data');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#export_data">export_data</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="export_data-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="export_data-expanded"><a name="L7"></a><tt class="py-lineno">   7</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L8"></a><tt class="py-lineno">   8</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L9"></a><tt class="py-lineno">   9</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to export 2D analysis grid data as a comma separated </tt> </tt>
<a name="L10"></a><tt class="py-lineno">  10</tt>  <tt class="py-line"><tt class="py-docstring">    value (*.CSV) file. The file will be saved into the current model </tt> </tt>
<a name="L11"></a><tt class="py-lineno">  11</tt>  <tt class="py-line"><tt class="py-docstring">    directory by default. </tt> </tt>
<a name="L12"></a><tt class="py-lineno">  12</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno">  13</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L14"></a><tt class="py-lineno">  14</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L15"></a><tt class="py-lineno">  15</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L16"></a><tt class="py-lineno">  16</tt>  <tt class="py-line"><tt class="py-docstring">    filename </tt> </tt>
<a name="L17"></a><tt class="py-lineno">  17</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter specifies the file where the data will be saved, and may </tt> </tt>
<a name="L18"></a><tt class="py-lineno">  18</tt>  <tt class="py-line"><tt class="py-docstring">    include a full pathname. However, be aware of the issues with </tt> </tt>
<a name="L19"></a><tt class="py-lineno">  19</tt>  <tt class="py-line"><tt class="py-docstring">    backslashes in filename parameters described here.</tt> </tt>
<a name="L20"></a><tt class="py-lineno">  20</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L21"></a><tt class="py-lineno">  21</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L22"></a><tt class="py-lineno">  22</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module py2ecotect._util=py2ecotect._util-module.html"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-1', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Function py2ecotect._util._convert_args_to_string()=py2ecotect._util-module.html#_convert_args_to_string"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-2', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.export"</tt><tt class="py-op">,</tt> <tt id="link-3" class="py-name" targets="Variable py2ecotect.app.movie.Movie.filename=py2ecotect.app.movie.Movie-class.html#filename"><a title="py2ecotect.app.movie.Movie.filename" class="py-name" href="#" onclick="return doclink('link-3', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L23"></a><tt class="py-lineno">  23</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable py2ecotect._app=py2ecotect-module.html#_app"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-4', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L24"></a><tt class="py-lineno">  24</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="import_data"></a><div id="import_data-def"><a name="L25"></a><tt class="py-lineno">  25</tt> <a class="py-toggle" href="#" id="import_data-toggle" onclick="return toggle('import_data');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#import_data">import_data</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">import_op</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="import_data-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="import_data-expanded"><a name="L26"></a><tt class="py-lineno">  26</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L27"></a><tt class="py-lineno">  27</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L28"></a><tt class="py-lineno">  28</tt>  <tt class="py-line"><tt class="py-docstring">    This command imports data from an external coma separated value (*.CSV) </tt> </tt>
<a name="L29"></a><tt class="py-lineno">  29</tt>  <tt class="py-line"><tt class="py-docstring">    file into the 2D analysis grid.</tt> </tt>
<a name="L30"></a><tt class="py-lineno">  30</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L31"></a><tt class="py-lineno">  31</tt>  <tt class="py-line"><tt class="py-docstring">    When importing grid data you can perform a range of operations to </tt> </tt>
<a name="L32"></a><tt class="py-lineno">  32</tt>  <tt class="py-line"><tt class="py-docstring">    transform the grid information, where XXX can be one of the values shown </tt> </tt>
<a name="L33"></a><tt class="py-lineno">  33</tt>  <tt class="py-line"><tt class="py-docstring">    in the following table. </tt> </tt>
<a name="L34"></a><tt class="py-lineno">  34</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L35"></a><tt class="py-lineno">  35</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L36"></a><tt class="py-lineno">  36</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L37"></a><tt class="py-lineno">  37</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L38"></a><tt class="py-lineno">  38</tt>  <tt class="py-line"><tt class="py-docstring">    filename </tt> </tt>
<a name="L39"></a><tt class="py-lineno">  39</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter specifies the file where the data will be imported from, </tt> </tt>
<a name="L40"></a><tt class="py-lineno">  40</tt>  <tt class="py-line"><tt class="py-docstring">    and may include a full pathname. However, be aware of the issues with </tt> </tt>
<a name="L41"></a><tt class="py-lineno">  41</tt>  <tt class="py-line"><tt class="py-docstring">    backslashes in filename parameters described here.</tt> </tt>
<a name="L42"></a><tt class="py-lineno">  42</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L43"></a><tt class="py-lineno">  43</tt>  <tt class="py-line"><tt class="py-docstring">    import_op</tt> </tt>
<a name="L44"></a><tt class="py-lineno">  44</tt>  <tt class="py-line"><tt class="py-docstring">    Refer to table below </tt> </tt>
<a name="L45"></a><tt class="py-lineno">  45</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L46"></a><tt class="py-lineno">  46</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">  47</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L48"></a><tt class="py-lineno">  48</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Import Operations </tt> </tt>
<a name="L49"></a><tt class="py-lineno">  49</tt>  <tt class="py-line"><tt class="py-docstring">    Command Suffix Description </tt> </tt>
<a name="L50"></a><tt class="py-lineno">  50</tt>  <tt class="py-line"><tt class="py-docstring">            If no value is appended, current grid data is overwritten. </tt> </tt>
<a name="L51"></a><tt class="py-lineno">  51</tt>  <tt class="py-line"><tt class="py-docstring">    subtract Subtract imported data from existing data. </tt> </tt>
<a name="L52"></a><tt class="py-lineno">  52</tt>  <tt class="py-line"><tt class="py-docstring">    add Add imported data to existing data. </tt> </tt>
<a name="L53"></a><tt class="py-lineno">  53</tt>  <tt class="py-line"><tt class="py-docstring">    divide Divide existing data by imported data. </tt> </tt>
<a name="L54"></a><tt class="py-lineno">  54</tt>  <tt class="py-line"><tt class="py-docstring">    percentage Show existing data as a percentage of imported data. </tt> </tt>
<a name="L55"></a><tt class="py-lineno">  55</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno">  56</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L57"></a><tt class="py-lineno">  57</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-5', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-6', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.import."</tt> <tt class="py-op">+</tt> <tt class="py-name">import_op</tt><tt class="py-op">,</tt>  </tt>
<a name="L58"></a><tt class="py-lineno">  58</tt>  <tt class="py-line">                                                 <tt id="link-7" class="py-name"><a title="py2ecotect.app.movie.Movie.filename" class="py-name" href="#" onclick="return doclink('link-7', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L59"></a><tt class="py-lineno">  59</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-8', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt>     </tt>
</div><a name="L60"></a><tt class="py-lineno">  60</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="fit_selection"></a><div id="fit_selection-def"><a name="L61"></a><tt class="py-lineno">  61</tt> <a class="py-toggle" href="#" id="fit_selection-toggle" onclick="return toggle('fit_selection');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#fit_selection">fit_selection</a><tt class="py-op">(</tt><tt class="py-param">fit_form</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="fit_selection-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="fit_selection-expanded"><a name="L62"></a><tt class="py-lineno">  62</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L63"></a><tt class="py-lineno">  63</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L64"></a><tt class="py-lineno">  64</tt>  <tt class="py-line"><tt class="py-docstring">    Fits the analysis grid to the extents of currently selected objects. </tt> </tt>
<a name="L65"></a><tt class="py-lineno">  65</tt>  <tt class="py-line"><tt class="py-docstring">    This is the same as selecting the Fit to Selected Objects button in the </tt> </tt>
<a name="L66"></a><tt class="py-lineno">  66</tt>  <tt class="py-line"><tt class="py-docstring">    Analysis Grid panel. Calling this method updates the grid.max, grid.min </tt> </tt>
<a name="L67"></a><tt class="py-lineno">  67</tt>  <tt class="py-line"><tt class="py-docstring">    and grid.average properties. </tt> </tt>
<a name="L68"></a><tt class="py-lineno">  68</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L69"></a><tt class="py-lineno">  69</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L70"></a><tt class="py-lineno">  70</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L71"></a><tt class="py-lineno">  71</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L72"></a><tt class="py-lineno">  72</tt>  <tt class="py-line"><tt class="py-docstring">    [fit_form] </tt> </tt>
<a name="L73"></a><tt class="py-lineno">  73</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter determines whether the grid fits to the form as </tt> </tt>
<a name="L74"></a><tt class="py-lineno">  74</tt>  <tt class="py-line"><tt class="py-docstring">    well as the extents of the selected objects. This is a boolean value </tt> </tt>
<a name="L75"></a><tt class="py-lineno">  75</tt>  <tt class="py-line"><tt class="py-docstring">    where 1 or true represents the affirmative and 0 or false the negative. </tt> </tt>
<a name="L76"></a><tt class="py-lineno">  76</tt>  <tt class="py-line"><tt class="py-docstring">  </tt> </tt>
<a name="L77"></a><tt class="py-lineno">  77</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L78"></a><tt class="py-lineno">  78</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-9', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-10', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.fit.selection"</tt><tt class="py-op">,</tt>  </tt>
<a name="L79"></a><tt class="py-lineno">  79</tt>  <tt class="py-line">                                                  <tt class="py-name">fit_form</tt><tt class="py-op">)</tt> </tt>
<a name="L80"></a><tt class="py-lineno">  80</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-11', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L81"></a><tt class="py-lineno">  81</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="fit_values"></a><div id="fit_values-def"><a name="L82"></a><tt class="py-lineno">  82</tt> <a class="py-toggle" href="#" id="fit_values-toggle" onclick="return toggle('fit_values');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#fit_values">fit_values</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="fit_values-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="fit_values-expanded"><a name="L83"></a><tt class="py-lineno">  83</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L84"></a><tt class="py-lineno">  84</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L85"></a><tt class="py-lineno">  85</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates the optimum scale required to fit the full range of currently </tt> </tt>
<a name="L86"></a><tt class="py-lineno">  86</tt>  <tt class="py-line"><tt class="py-docstring">    visible grid values. Calling this method updates the grid.scale property. </tt> </tt>
<a name="L87"></a><tt class="py-lineno">  87</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L88"></a><tt class="py-lineno">  88</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L89"></a><tt class="py-lineno">  89</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L90"></a><tt class="py-lineno">  90</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L91"></a><tt class="py-lineno">  91</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L92"></a><tt class="py-lineno">  92</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-12', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"grid.fit.values"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L93"></a><tt class="py-lineno">  93</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="load"></a><div id="load-def"><a name="L94"></a><tt class="py-lineno">  94</tt> <a class="py-toggle" href="#" id="load-toggle" onclick="return toggle('load');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#load">load</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="load-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="load-expanded"><a name="L95"></a><tt class="py-lineno">  95</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L96"></a><tt class="py-lineno">  96</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L97"></a><tt class="py-lineno">  97</tt>  <tt class="py-line"><tt class="py-docstring">    This command loads any analysis grid stored as a (*.GRD) binary data </tt> </tt>
<a name="L98"></a><tt class="py-lineno">  98</tt>  <tt class="py-line"><tt class="py-docstring">    file. The loaded file contains both 2D and 3D grid data (if it exists) </tt> </tt>
<a name="L99"></a><tt class="py-lineno">  99</tt>  <tt class="py-line"><tt class="py-docstring">    as well as all other grid settings. </tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt>  <tt class="py-line"><tt class="py-docstring">    filename </tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter specifies the file where the data will be imported from </tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt>  <tt class="py-line"><tt class="py-docstring">    and may include a full pathname. However, be aware of the issues with </tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt>  <tt class="py-line"><tt class="py-docstring">    backslashes in filename parameters described here.</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-13', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-14', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.import"</tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name"><a title="py2ecotect.app.movie.Movie.filename" class="py-name" href="#" onclick="return doclink('link-15', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-16', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L112"></a><tt class="py-lineno"> 112</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="reset"></a><div id="reset-def"><a name="L113"></a><tt class="py-lineno"> 113</tt> <a class="py-toggle" href="#" id="reset-toggle" onclick="return toggle('reset');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#reset">reset</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="reset-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="reset-expanded"><a name="L114"></a><tt class="py-lineno"> 114</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to reset all grid values back to zero. </tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-17', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"grid.reset"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L123"></a><tt class="py-lineno"> 123</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="save"></a><div id="save-def"><a name="L124"></a><tt class="py-lineno"> 124</tt> <a class="py-toggle" href="#" id="save-toggle" onclick="return toggle('save');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#save">save</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="save-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="save-expanded"><a name="L125"></a><tt class="py-lineno"> 125</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt>  <tt class="py-line"><tt class="py-docstring">    This command saves the analysis grid as a (*.GRD) binary data file. The </tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt>  <tt class="py-line"><tt class="py-docstring">    saved file contains both 2D and 3D grid data (if it exists) as well as </tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt>  <tt class="py-line"><tt class="py-docstring">    all other grid settings. </tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt>  <tt class="py-line"><tt class="py-docstring">    filename </tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter specifies the file where the data will be imported from, </tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt>  <tt class="py-line"><tt class="py-docstring">    and may include a full pathname. However, be aware of the issues with </tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt>  <tt class="py-line"><tt class="py-docstring">    backslashes in filename parameters described here. </tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-18', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-19', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.save"</tt><tt class="py-op">,</tt> <tt id="link-20" class="py-name"><a title="py2ecotect.app.movie.Movie.filename" class="py-name" href="#" onclick="return doclink('link-20', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-21', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L142"></a><tt class="py-lineno"> 142</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="show"></a><div id="show-def"><a name="L143"></a><tt class="py-lineno"> 143</tt> <a class="py-toggle" href="#" id="show-toggle" onclick="return toggle('show');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#show">show</a><tt class="py-op">(</tt><tt class="py-param">show</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="show-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="show-expanded"><a name="L144"></a><tt class="py-lineno"> 144</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt>  <tt class="py-line"><tt class="py-docstring">    Displays the current analysis grid in the model. </tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt>  <tt class="py-line"><tt class="py-docstring">    show </tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt>  <tt class="py-line"><tt class="py-docstring">    When given, this optional parameter determines whether to show or hide </tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt>  <tt class="py-line"><tt class="py-docstring">    the analysis grid in the main model view. This is a boolean value where </tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt>  <tt class="py-line"><tt class="py-docstring">    1 or true represents the affirmative and 0 or false the negative. If not </tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt>  <tt class="py-line"><tt class="py-docstring">    specified, this defaults to true. </tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-22', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-23', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"grid.show"</tt><tt class="py-op">,</tt> <tt id="link-24" class="py-name" targets="Method py2ecotect.app.graph.Graph.show()=py2ecotect.app.graph.Graph-class.html#show,Method py2ecotect.app.movie.Movie.show()=py2ecotect.app.movie.Movie-class.html#show,Method py2ecotect.app.sunpath.Sunpath.show()=py2ecotect.app.sunpath.Sunpath-class.html#show,Function py2ecotect.doc.grid.show()=py2ecotect.doc.grid-module.html#show"><a title="py2ecotect.app.graph.Graph.show
py2ecotect.app.movie.Movie.show
py2ecotect.app.sunpath.Sunpath.show
py2ecotect.doc.grid.show" class="py-name" href="#" onclick="return doclink('link-24', 'show', 'link-24');">show</a></tt><tt class="py-op">)</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-25', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L160"></a><tt class="py-lineno"> 160</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Properties</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="get_average"></a><div id="get_average-def"><a name="L163"></a><tt class="py-lineno"> 163</tt> <a class="py-toggle" href="#" id="get_average-toggle" onclick="return toggle('get_average');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_average">get_average</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_average-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_average-expanded"><a name="L164"></a><tt class="py-lineno"> 164</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns three values - the average value of all </tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt>  <tt class="py-line"><tt class="py-docstring">    enabled grid nodes, the number of enabled grid nodes, and the fraction </tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt>  <tt class="py-line"><tt class="py-docstring">    of enabled nodes above the clipping threshold (the minimum scale value). </tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt>  <tt class="py-line"><tt class="py-docstring">    This last value is only calculated when the Clip to Minimum option is </tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt>  <tt class="py-line"><tt class="py-docstring">    selected.</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt>  <tt class="py-line"><tt class="py-docstring">    Grids are generally rectilinear in shape. However, more complex shapes </tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt>  <tt class="py-line"><tt class="py-docstring">    can be accommodated using a large grid with some disabled nodes - this </tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt>  <tt class="py-line"><tt class="py-docstring">    is how the Fit Grid to Selected Objects button works. Note that the </tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt>  <tt class="py-line"><tt class="py-docstring">    above values are based on the number of enabled nodes in the grid, </tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt>  <tt class="py-line"><tt class="py-docstring">    irrespective of whether they are visible or not due to a clipping </tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt>  <tt class="py-line"><tt class="py-docstring">    threshold. </tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt>  <tt class="py-line"><tt class="py-docstring">    avgValue </tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt>  <tt class="py-line"><tt class="py-docstring">    The average value of all enabled nodes within the currently displayed </tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt>  <tt class="py-line"><tt class="py-docstring">    grid. </tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt>  <tt class="py-line"><tt class="py-docstring">    nodeCount </tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt>  <tt class="py-line"><tt class="py-docstring">    The number of enabled nodes within the currently displayed grid. </tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt>  <tt class="py-line"><tt class="py-docstring">    fractAbove </tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt>  <tt class="py-line"><tt class="py-docstring">    The fraction of enabled nodes whose current data value is above the </tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt>  <tt class="py-line"><tt class="py-docstring">    minimum scale when the Clip to Minimum option is selected for the </tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt>  <tt class="py-line"><tt class="py-docstring">    currently displayed grid. </tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-26', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.average"</tt><tt class="py-op">)</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-27', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Function py2ecotect._util._convert_str_to_list()=py2ecotect._util-module.html#_convert_str_to_list"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-28', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L200"></a><tt class="py-lineno"> 200</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_axis"></a><div id="get_axis-def"><a name="L201"></a><tt class="py-lineno"> 201</tt> <a class="py-toggle" href="#" id="get_axis-toggle" onclick="return toggle('get_axis');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_axis">get_axis</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_axis-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_axis-expanded"><a name="L202"></a><tt class="py-lineno"> 202</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the grid axis, being the axis within which the 2D slice has </tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt>  <tt class="py-line"><tt class="py-docstring">    been drawn. The value returned is a single integer value corresponding </tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt>  <tt class="py-line"><tt class="py-docstring">    with the following table. </tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt>  <tt class="py-line"><tt class="py-docstring">    axis </tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value representing the current grid axis with a value from </tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt>  <tt class="py-line"><tt class="py-docstring">    the following Grid Axis table. </tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Axis Value Axis </tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt>  <tt class="py-line"><tt class="py-docstring">    0 XY Axis </tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt>  <tt class="py-line"><tt class="py-docstring">    1 YZ Axis </tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt>  <tt class="py-line"><tt class="py-docstring">    2 XZ Axis </tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-29', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.axis"</tt><tt class="py-op">)</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-30', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Function py2ecotect._util._convert_str_to_type()=py2ecotect._util-module.html#_convert_str_to_type"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-31', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L228"></a><tt class="py-lineno"> 228</tt>  <tt class="py-line"> </tt>
<a name="set_axis"></a><div id="set_axis-def"><a name="L229"></a><tt class="py-lineno"> 229</tt> <a class="py-toggle" href="#" id="set_axis-toggle" onclick="return toggle('set_axis');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_axis">set_axis</a><tt class="py-op">(</tt><tt class="py-param">axis</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_axis-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_axis-expanded"><a name="L230"></a><tt class="py-lineno"> 230</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the grid axis, being the axis within which the 2D slice has been </tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt>  <tt class="py-line"><tt class="py-docstring">    drawn. </tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt>  <tt class="py-line"><tt class="py-docstring">    axis </tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt>  <tt class="py-line"><tt class="py-docstring">    A single integer value corresponding with the following Grid Axis table. </tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Axis Value Axis </tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt>  <tt class="py-line"><tt class="py-docstring">    0 XY Axis </tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt>  <tt class="py-line"><tt class="py-docstring">    1 YZ Axis </tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt>  <tt class="py-line"><tt class="py-docstring">    2 XZ Axis </tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-32', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-33', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.axis"</tt><tt class="py-op">,</tt> <tt class="py-name">axis</tt><tt class="py-op">)</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-34', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L251"></a><tt class="py-lineno"> 251</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_cell"></a><div id="get_cell-def"><a name="L252"></a><tt class="py-lineno"> 252</tt> <a class="py-toggle" href="#" id="get_cell-toggle" onclick="return toggle('get_cell');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_cell">get_cell</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_cell-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_cell-expanded"><a name="L253"></a><tt class="py-lineno"> 253</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the value stored in the specified grid cell. Two values are </tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt>  <tt class="py-line"><tt class="py-docstring">    returned - the first is the actual value of the cell in the current </tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt>  <tt class="py-line"><tt class="py-docstring">    units, whilst the second is the state of the cell. The possible state </tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt>  <tt class="py-line"><tt class="py-docstring">    values that can be returned are given in the following table. Each grid </tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt>  <tt class="py-line"><tt class="py-docstring">    cell can store up to 5 different data values. </tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical </tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt>  <tt class="py-line"><tt class="py-docstring">    position of the required cell within the grid. Each must be an integer </tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt>  <tt class="py-line"><tt class="py-docstring">    between 0 and the current grid size - 1 in the relevant grid axis. </tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt>  <tt class="py-line"><tt class="py-docstring">    [index] </tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter specifies the index of the specified data value </tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt>  <tt class="py-line"><tt class="py-docstring">    to be retieved and can be an integer between 0 and 4. If this parameter </tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt>  <tt class="py-line"><tt class="py-docstring">    is not specified, the currently selected data index is used. </tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt>  <tt class="py-line"><tt class="py-docstring">    The current data value at the specified grid cell.</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-35', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-36', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.cell"</tt><tt class="py-op">,</tt>  </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt>  <tt class="py-line">                                                  <tt id="link-37" class="py-name" targets="Variable py2ecotect.obj._node.Node.position=py2ecotect.obj._node.Node-class.html#position"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-37', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-38" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-38', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt>  </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt>  <tt class="py-line">                                                  <tt id="link-39" class="py-name" targets="Method py2ecotect.doc.select.Select.index()=py2ecotect.doc.select.Select-class.html#index"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-39', 'index', 'link-39');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-40', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-41', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-42', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L286"></a><tt class="py-lineno"> 286</tt>  <tt class="py-line"> </tt>
<a name="set_cell"></a><div id="set_cell-def"><a name="L287"></a><tt class="py-lineno"> 287</tt> <a class="py-toggle" href="#" id="set_cell-toggle" onclick="return toggle('set_cell');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_cell">set_cell</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_cell-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_cell-expanded"><a name="L288"></a><tt class="py-lineno"> 288</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the value to be stored in the specified grid cell. </tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt>  <tt class="py-line"><tt class="py-docstring">    grid axis. </tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter is the decimal value to be stored within the cell. </tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt>  <tt class="py-line"><tt class="py-docstring">    [index] </tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt>  <tt class="py-line"><tt class="py-docstring">    Each grid cell can store up to 5 different data values. This optional </tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt>  <tt class="py-line"><tt class="py-docstring">    parameter specifies which particular slot the specified value should be </tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt>  <tt class="py-line"><tt class="py-docstring">    stored in, and can be an integer between 0 and 4. If this parameter is </tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt>  <tt class="py-line"><tt class="py-docstring">    not specified, the currently displayed index is used by default.</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-43', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-44', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.cell"</tt><tt class="py-op">,</tt>  </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt>  <tt class="py-line">                                                  <tt id="link-45" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-45', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-46" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-46', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt>  </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt>  <tt class="py-line">                                                 <tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-47" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-47', 'index', 'link-39');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-48', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L315"></a><tt class="py-lineno"> 315</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_data"></a><div id="get_data-def"><a name="L316"></a><tt class="py-lineno"> 316</tt> <a class="py-toggle" href="#" id="get_data-toggle" onclick="return toggle('get_data');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_data">get_data</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_data-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_data-expanded"><a name="L317"></a><tt class="py-lineno"> 317</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt>  <tt class="py-line"><tt class="py-docstring">    Each grid cell of the analysis grid can store up to 5 different values, </tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt>  <tt class="py-line"><tt class="py-docstring">    as displayed within the selection list in the DATA &amp; SCALE section of </tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt>  <tt class="py-line"><tt class="py-docstring">    the Analysis Grid Panel. This property gets the currently displayed data </tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt>  <tt class="py-line"><tt class="py-docstring">    index. </tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt>  <tt class="py-line"><tt class="py-docstring">    The index of the grid cell data currently displayed. This is given as an </tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt>  <tt class="py-line"><tt class="py-docstring">    integer value in the range 0 to 4. </tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-49', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.data"</tt><tt class="py-op">)</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-50', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-51', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L337"></a><tt class="py-lineno"> 337</tt>  <tt class="py-line"> </tt>
<a name="set_data"></a><div id="set_data-def"><a name="L338"></a><tt class="py-lineno"> 338</tt> <a class="py-toggle" href="#" id="set_data-toggle" onclick="return toggle('set_data');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_data">set_data</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_data-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_data-expanded"><a name="L339"></a><tt class="py-lineno"> 339</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt>  <tt class="py-line"><tt class="py-docstring">    Each grid cell of the analysis grid can store up to 5 different values. </tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt>  <tt class="py-line"><tt class="py-docstring">    This property sets the grid cell index to be displayed. </tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt>  <tt class="py-line"><tt class="py-docstring">    The index of the grid cell data to be displayed, given as an integer </tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt>  <tt class="py-line"><tt class="py-docstring">    value in the range 0 to 4.</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-52', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-53', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.data"</tt><tt class="py-op">,</tt> <tt id="link-54" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-54', 'index', 'link-39');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-55', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L354"></a><tt class="py-lineno"> 354</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_description"></a><div id="get_description-def"><a name="L355"></a><tt class="py-lineno"> 355</tt> <a class="py-toggle" href="#" id="get_description-toggle" onclick="return toggle('get_description');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_description">get_description</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_description-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_description-expanded"><a name="L356"></a><tt class="py-lineno"> 356</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt>  <tt class="py-line"><tt class="py-docstring">    Each cell of the analysis grid can store up to 5 different values, each </tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt>  <tt class="py-line"><tt class="py-docstring">    in an individual slot. This command returns the description for the </tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt>  <tt class="py-line"><tt class="py-docstring">    specified slot. If no slot is specified, the description returned is for </tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt>  <tt class="py-line"><tt class="py-docstring">    the currently selected index. </tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter specifies the particular slot to return the </tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt>  <tt class="py-line"><tt class="py-docstring">    description for, and can be an integer in the range 0 to 4. </tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt>  <tt class="py-line"><tt class="py-docstring">    description </tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the description of the nominated slot.</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-56', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-57', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.description"</tt><tt class="py-op">,</tt>  </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt>  <tt class="py-line">                                                 <tt id="link-58" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-58', 'index', 'link-39');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-59', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-60', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-61', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L381"></a><tt class="py-lineno"> 381</tt>  <tt class="py-line"> </tt>
<a name="set_description"></a><div id="set_description-def"><a name="L382"></a><tt class="py-lineno"> 382</tt> <a class="py-toggle" href="#" id="set_description-toggle" onclick="return toggle('set_description');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_description">set_description</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">description</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_description-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_description-expanded"><a name="L383"></a><tt class="py-lineno"> 383</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt>  <tt class="py-line"><tt class="py-docstring">    Each cell of the analysis grid can store up to 5 different values, each </tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt>  <tt class="py-line"><tt class="py-docstring">    in an individual slot. This command sets the description for the </tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt>  <tt class="py-line"><tt class="py-docstring">    specified slot. If no slot is specified, the description is set for the </tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt>  <tt class="py-line"><tt class="py-docstring">    currently displayed index. </tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter specifies the particular slot to set the </tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt>  <tt class="py-line"><tt class="py-docstring">    description for, and can be an integer in the range 0 to 4. </tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt>  <tt class="py-line"><tt class="py-docstring">    description </tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt>  <tt class="py-line"><tt class="py-docstring">    The description to be used for the nominated slot.</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-62', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-63', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.description"</tt><tt class="py-op">,</tt>  </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt>  <tt class="py-line">                                                 <tt id="link-64" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-64', 'index', 'link-39');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">description</tt><tt class="py-op">)</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-65', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L404"></a><tt class="py-lineno"> 404</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_flag"></a><div id="get_flag-def"><a name="L405"></a><tt class="py-lineno"> 405</tt> <a class="py-toggle" href="#" id="get_flag-toggle" onclick="return toggle('get_flag');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_flag">get_flag</a><tt class="py-op">(</tt><tt class="py-param">flag</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_flag-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_flag-expanded"><a name="L406"></a><tt class="py-lineno"> 406</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt>  <tt class="py-line"><tt class="py-docstring">    The analysis grid uses a series of boolean flags to control how it is </tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt>  <tt class="py-line"><tt class="py-docstring">    displayed in both the View and OpenGL canvasses. This property returns </tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt>  <tt class="py-line"><tt class="py-docstring">    the current state for the flag value/s specified. </tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt>  <tt class="py-line"><tt class="py-docstring">    flag </tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt>  <tt class="py-line"><tt class="py-docstring">    An integer that specifies which flag state to return, according to the </tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt>  <tt class="py-line"><tt class="py-docstring">    following Grid Flags table</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt>  <tt class="py-line"><tt class="py-docstring">    To return the values for multiple flags at once, add their respective </tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt>  <tt class="py-line"><tt class="py-docstring">    values together. For example, using an integer value of 18 will return </tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt>  <tt class="py-line"><tt class="py-docstring">    the state for both the values and contours flags. </tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt>  <tt class="py-line"><tt class="py-docstring">    [state] </tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt>  <tt class="py-line"><tt class="py-docstring">    The state of the specified flag(s). This is a boolean value where 1 or </tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt>  <tt class="py-line"><tt class="py-docstring">    true represents the affirmative and 0 or false the negative. </tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Flag Codes </tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt>  <tt class="py-line"><tt class="py-docstring">    axis 1 Display grid axis with units. </tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt>  <tt class="py-line"><tt class="py-docstring">    values 2 Display text values at each grid node. </tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt>  <tt class="py-line"><tt class="py-docstring">    extents 4 Display a bounding box showing the full 3D grid space. </tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt>  <tt class="py-line"><tt class="py-docstring">     8 UNUSED. </tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt>  <tt class="py-line"><tt class="py-docstring">    contours 16 Display contours if variable data is available. </tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt>  <tt class="py-line"><tt class="py-docstring">    selected 32 Display text values at selected grid nodes only. </tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt>  <tt class="py-line"><tt class="py-docstring">    peaks 64 Display text values at peaks and troughs between values. </tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt>  <tt class="py-line"><tt class="py-docstring">    colours 128 Display colour-shaded grid squares. </tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt>  <tt class="py-line"><tt class="py-docstring">     256 UNUSED. </tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt>  <tt class="py-line"><tt class="py-docstring">    elastic 512 Use elastic method when dragging axial nodes. </tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt>  <tt class="py-line"><tt class="py-docstring">     1024 UNUSED. </tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt>  <tt class="py-line"><tt class="py-docstring">    clip 2048 Clip the displayed grid to those nodes above the minimum range. </tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt>  <tt class="py-line"><tt class="py-docstring">    average 4096 Display the average of all visible values at bottom of </tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt>  <tt class="py-line"><tt class="py-docstring">    canvas. </tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt>  <tt class="py-line"><tt class="py-docstring">    lines 8192 Display grid lines. </tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt>  <tt class="py-line"><tt class="py-docstring">    3d 16384 Display grid values as a 3D peturbed surface. </tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt>  <tt class="py-line"><tt class="py-docstring">    daylight 32768 Indicates that grid displays valid daylight analysis </tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt>  <tt class="py-line"><tt class="py-docstring">    results. </tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-66', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-67', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.flag"</tt><tt class="py-op">,</tt>  </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt>  <tt class="py-line">                                                 <tt class="py-name">flag</tt><tt class="py-op">)</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-68', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-69', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-70', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">bool</tt><tt class="py-op">)</tt> </tt>
</div><a name="L458"></a><tt class="py-lineno"> 458</tt>  <tt class="py-line"> </tt>
<a name="set_flag"></a><div id="set_flag-def"><a name="L459"></a><tt class="py-lineno"> 459</tt> <a class="py-toggle" href="#" id="set_flag-toggle" onclick="return toggle('set_flag');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_flag">set_flag</a><tt class="py-op">(</tt><tt class="py-param">flag</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_flag-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_flag-expanded"><a name="L460"></a><tt class="py-lineno"> 460</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt>  <tt class="py-line"><tt class="py-docstring">    The analysis grid uses a series of boolean flags to control how it is </tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt>  <tt class="py-line"><tt class="py-docstring">    displayed in both the View and OpenGL canvasses. This property sets the </tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt>  <tt class="py-line"><tt class="py-docstring">    current state for the flag value/s specified. </tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt>  <tt class="py-line"><tt class="py-docstring">    flag </tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt>  <tt class="py-line"><tt class="py-docstring">    An integer that specifies which flag state to set, according to the </tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt>  <tt class="py-line"><tt class="py-docstring">    following Grid Flags table.</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt>  <tt class="py-line"><tt class="py-docstring">    To set the values for multiple flags at once, add their respective </tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt>  <tt class="py-line"><tt class="py-docstring">    values together. For example, using an integer value of 18 will set the </tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt>  <tt class="py-line"><tt class="py-docstring">    state for both the values and contours flags. </tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt>  <tt class="py-line"><tt class="py-docstring">    [state] </tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter determines if the specified flag(s) are set or </tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt>  <tt class="py-line"><tt class="py-docstring">    not. This is a boolean value where 1 or true represents the affirmative </tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt>  <tt class="py-line"><tt class="py-docstring">    and 0 or false the negative. If this paramater is not specified, the </tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt>  <tt class="py-line"><tt class="py-docstring">    default state is set to true. </tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Flag Codes Token Value Description </tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt>  <tt class="py-line"><tt class="py-docstring">    axis 1 Display grid axis with units. </tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt>  <tt class="py-line"><tt class="py-docstring">    values 2 Display text values at each grid node. </tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt>  <tt class="py-line"><tt class="py-docstring">    extents 4 Display a bounding box showing the full 3D grid space. </tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt>  <tt class="py-line"><tt class="py-docstring">     8 UNUSED. </tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt>  <tt class="py-line"><tt class="py-docstring">    contours 16 Display contours if variable data is available. </tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt>  <tt class="py-line"><tt class="py-docstring">    selected 32 Display text values at selected grid nodes only. </tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt>  <tt class="py-line"><tt class="py-docstring">    peaks 64 Display text values at peaks and troughs between values. </tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt>  <tt class="py-line"><tt class="py-docstring">    colours 128 Display colour-shaded grid squares. </tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt>  <tt class="py-line"><tt class="py-docstring">     256 UNUSED. </tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt>  <tt class="py-line"><tt class="py-docstring">    elastic 512 Use elastic method when dragging axial nodes. </tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt>  <tt class="py-line"><tt class="py-docstring">     1024 UNUSED. </tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt>  <tt class="py-line"><tt class="py-docstring">    clip 2048 Clip the displayed grid to those nodes above the minimum range. </tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt>  <tt class="py-line"><tt class="py-docstring">    average 4096 Display the average of all visible values at bottom of </tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt>  <tt class="py-line"><tt class="py-docstring">    canvas. </tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt>  <tt class="py-line"><tt class="py-docstring">    lines 8192 Display grid lines. </tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt>  <tt class="py-line"><tt class="py-docstring">    3d 16384 Display grid values as a 3D peturbed surface. </tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt>  <tt class="py-line"><tt class="py-docstring">    daylight 32768 Indicates that grid displays valid daylight analysis </tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt>  <tt class="py-line"><tt class="py-docstring">    results. </tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-71', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-72', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.flag"</tt><tt class="py-op">,</tt>  </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt>  <tt class="py-line">                                                 <tt class="py-name">flag</tt><tt class="py-op">,</tt> <tt id="link-73" class="py-name" targets="Class py2ecotect.obj._object._Object.state=py2ecotect.obj._object._Object.state-class.html"><a title="py2ecotect.obj._object._Object.state" class="py-name" href="#" onclick="return doclink('link-73', 'state', 'link-73');">state</a></tt><tt class="py-op">)</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-74', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L509"></a><tt class="py-lineno"> 509</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="set_fraction"></a><div id="set_fraction-def"><a name="L510"></a><tt class="py-lineno"> 510</tt> <a class="py-toggle" href="#" id="set_fraction-toggle" onclick="return toggle('set_fraction');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_fraction">set_fraction</a><tt class="py-op">(</tt><tt class="py-param">fraction</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_fraction-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_fraction-expanded"><a name="L511"></a><tt class="py-lineno"> 511</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt>  <tt class="py-line"><tt class="py-docstring">    This property is a shortcut for setting the grid base offset when </tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt>  <tt class="py-line"><tt class="py-docstring">    animating through 3D data. Instead of giving an absolute base offset </tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt>  <tt class="py-line"><tt class="py-docstring">    using the set.grid.offset property, you can instead set the fraction of </tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt>  <tt class="py-line"><tt class="py-docstring">    the 2D grid section between the minimum and maximum extents in the 3D </tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt>  <tt class="py-line"><tt class="py-docstring">    grid. </tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt>  <tt class="py-line"><tt class="py-docstring">    fraction </tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt>  <tt class="py-line"><tt class="py-docstring">    A decimal number between 0 and 1. This property can also be used to </tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt>  <tt class="py-line"><tt class="py-docstring">    cycle through indexed grid animation frames using the grid3d.setframe </tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt>  <tt class="py-line"><tt class="py-docstring">    command. </tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-75', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-76', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.fraction"</tt><tt class="py-op">,</tt>  </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt>  <tt class="py-line">                                                 <tt class="py-name">fraction</tt><tt class="py-op">)</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-77', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L531"></a><tt class="py-lineno"> 531</tt>  <tt class="py-line"> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt>  <tt class="py-line"> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_max_extent"></a><div id="get_max_extent-def"><a name="L534"></a><tt class="py-lineno"> 534</tt> <a class="py-toggle" href="#" id="get_max_extent-toggle" onclick="return toggle('get_max_extent');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_max_extent">get_max_extent</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_max_extent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_max_extent-expanded"><a name="L535"></a><tt class="py-lineno"> 535</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt>  <tt class="py-line"><tt class="py-docstring">    Retreives the values for the maximum extent of the grid for the x y and </tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt>  <tt class="py-line"><tt class="py-docstring">    z axes. The axial values are given in absolute world co-ordinates. </tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt>  <tt class="py-line"><tt class="py-docstring">    x, y, z </tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt>  <tt class="py-line"><tt class="py-docstring">    The absolute position in the X, Y and Z axis of the maximun extents of </tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt>  <tt class="py-line"><tt class="py-docstring">    the analysis grid in 3 dimensional model space.</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-78', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.max"</tt><tt class="py-op">)</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-79', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-80', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L553"></a><tt class="py-lineno"> 553</tt>  <tt class="py-line"> </tt>
<a name="set_max_extent"></a><div id="set_max_extent-def"><a name="L554"></a><tt class="py-lineno"> 554</tt> <a class="py-toggle" href="#" id="set_max_extent-toggle" onclick="return toggle('set_max_extent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_max_extent">set_max_extent</a><tt class="py-op">(</tt><tt class="py-param">absolute_position</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_max_extent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_max_extent-expanded"><a name="L555"></a><tt class="py-lineno"> 555</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the maximum values of the grid extents for the x, y and z axes. The </tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt>  <tt class="py-line"><tt class="py-docstring">    axial values are specified in absolute world co-ordinates. </tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt>  <tt class="py-line"><tt class="py-docstring">    absolute_position </tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt>  <tt class="py-line"><tt class="py-docstring">    A list of three values that represent the absolute position in the </tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt>  <tt class="py-line"><tt class="py-docstring">    X, Y and Z axis of the maximun extents of the analysis grid in 3 </tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt>  <tt class="py-line"><tt class="py-docstring">    dimensional model space. </tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-81', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-82', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.max"</tt><tt class="py-op">,</tt>  </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-83', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L574"></a><tt class="py-lineno"> 574</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_min_extent"></a><div id="get_min_extent-def"><a name="L575"></a><tt class="py-lineno"> 575</tt> <a class="py-toggle" href="#" id="get_min_extent-toggle" onclick="return toggle('get_min_extent');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_min_extent">get_min_extent</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_min_extent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_min_extent-expanded"><a name="L576"></a><tt class="py-lineno"> 576</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt>  <tt class="py-line"><tt class="py-docstring">    Retreives the values for the minimum extent of the grid for the x y and </tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt>  <tt class="py-line"><tt class="py-docstring">    z axes. The axial values are given in absolute world co-ordinates. </tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt>  <tt class="py-line"><tt class="py-docstring">    x, y, z </tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt>  <tt class="py-line"><tt class="py-docstring">    The absolute position in the X, Y and Z axis of the minimun extents of </tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt>  <tt class="py-line"><tt class="py-docstring">    the analysis grid in 3 dimensional model space.</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-84', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.min"</tt><tt class="py-op">)</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-85', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-86', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L594"></a><tt class="py-lineno"> 594</tt>  <tt class="py-line"> </tt>
<a name="set_min_extent"></a><div id="set_min_extent-def"><a name="L595"></a><tt class="py-lineno"> 595</tt> <a class="py-toggle" href="#" id="set_min_extent-toggle" onclick="return toggle('set_min_extent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_min_extent">set_min_extent</a><tt class="py-op">(</tt><tt class="py-param">absolute_position</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_min_extent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_min_extent-expanded"><a name="L596"></a><tt class="py-lineno"> 596</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the minimum values of the grid extents in theX, Y and Z axes. </tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt>  <tt class="py-line"><tt class="py-docstring">    absolute_position </tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt>  <tt class="py-line"><tt class="py-docstring">    A list of three values that represent the absolute position in the </tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt>  <tt class="py-line"><tt class="py-docstring">    X, Y and Z axis of the minimun extents of the analysis grid in 3 </tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt>  <tt class="py-line"><tt class="py-docstring">    dimensional model space.</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-87" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-87', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-88', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.min"</tt><tt class="py-op">,</tt>  </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt>  <tt class="py-line">                                                  <tt class="py-name">absolute_position</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-89', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L614"></a><tt class="py-lineno"> 614</tt>  <tt class="py-line"> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_offset"></a><div id="get_offset-def"><a name="L616"></a><tt class="py-lineno"> 616</tt> <a class="py-toggle" href="#" id="get_offset-toggle" onclick="return toggle('get_offset');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_offset">get_offset</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_offset-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_offset-expanded"><a name="L617"></a><tt class="py-lineno"> 617</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the grid base value, the offset distance of the 2D grid </tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt>  <tt class="py-line"><tt class="py-docstring">    section from the base of the 3D grid. See the grid.axis command for more </tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt>  <tt class="py-line"><tt class="py-docstring">    information. </tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt>  <tt class="py-line"><tt class="py-docstring">    offset </tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt>  <tt class="py-line"><tt class="py-docstring">    The offset distance of the 2D grid section from the base of the 3D grid, </tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt>  <tt class="py-line"><tt class="py-docstring">    for the currently selected axis.</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-90', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.offset"</tt><tt class="py-op">)</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-91', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-92', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L636"></a><tt class="py-lineno"> 636</tt>  <tt class="py-line"> </tt>
<a name="set_offset"></a><div id="set_offset-def"><a name="L637"></a><tt class="py-lineno"> 637</tt> <a class="py-toggle" href="#" id="set_offset-toggle" onclick="return toggle('set_offset');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_offset">set_offset</a><tt class="py-op">(</tt><tt class="py-param">offset</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_offset-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_offset-expanded"><a name="L638"></a><tt class="py-lineno"> 638</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the grid base value. If full 3D grid values have been calculated, </tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt>  <tt class="py-line"><tt class="py-docstring">    you can use this value to animate the grid by cycling between the </tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt>  <tt class="py-line"><tt class="py-docstring">    minimum and maximum range in the current axis. </tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt>  <tt class="py-line"><tt class="py-docstring">    base </tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt>  <tt class="py-line"><tt class="py-docstring">    The offset distance of the 2D grid section from the base of the 3D grid, </tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt>  <tt class="py-line"><tt class="py-docstring">    for the currently selected axis. See the grid.axis </tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-93', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-94', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.offset"</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-95', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L654"></a><tt class="py-lineno"> 654</tt>  <tt class="py-line"> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_position"></a><div id="get_position-def"><a name="L656"></a><tt class="py-lineno"> 656</tt> <a class="py-toggle" href="#" id="get_position-toggle" onclick="return toggle('get_position');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_position">get_position</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_position-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_position-expanded"><a name="L657"></a><tt class="py-lineno"> 657</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the position of a grid point. Three values are returned, being </tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt>  <tt class="py-line"><tt class="py-docstring">    the x y and z coordinates of the specified cell. </tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt>  <tt class="py-line"><tt class="py-docstring">    grid axis. </tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt>  <tt class="py-line"><tt class="py-docstring">    x, y, z </tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt>  <tt class="py-line"><tt class="py-docstring">    Represents the absolute position in the X, Y and Z axis of the grid cell </tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt>  <tt class="py-line"><tt class="py-docstring">    node in 3 dimensional model space.</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-96', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-97', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.position"</tt><tt class="py-op">,</tt>  </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt>  <tt class="py-line">                                                  <tt id="link-98" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-98', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt>  <tt class="py-line">                                                  <tt id="link-99" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-99', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-100', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-101', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-102', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L684"></a><tt class="py-lineno"> 684</tt>  <tt class="py-line"> </tt>
<a name="set_position"></a><div id="set_position-def"><a name="L685"></a><tt class="py-lineno"> 685</tt> <a class="py-toggle" href="#" id="set_position-toggle" onclick="return toggle('set_position');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_position">set_position</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">pos</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_position-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_position-expanded"><a name="L686"></a><tt class="py-lineno"> 686</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the position of a grid point. Note that setting this value is only </tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt>  <tt class="py-line"><tt class="py-docstring">    possible when the grid has been form fit to selected objects using the </tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt>  <tt class="py-line"><tt class="py-docstring">    grid.fit.selection command, or by selecting the Fit to Selected Objects </tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt>  <tt class="py-line"><tt class="py-docstring">    &gt; 3D Form button in the Analysis Grid panel. </tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt>  <tt class="py-line"><tt class="py-docstring">    axis. </tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt>  <tt class="py-line"><tt class="py-docstring">    pos </tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter is the absolute world coordinate of the cell in the </tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt>  <tt class="py-line"><tt class="py-docstring">    current grid axis. Thus if the axis is currently set to XY (0), then a </tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt>  <tt class="py-line"><tt class="py-docstring">    value of 1500 would equate to a height of 1.5m in the z axis. </tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-103', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-104', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.position"</tt><tt class="py-op">,</tt>  </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt>  <tt class="py-line">                                                  <tt id="link-105" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-105', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt>  <tt class="py-line">                                                  <tt id="link-106" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-106', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt>  <tt class="py-line">                                                  <tt class="py-name">pos</tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-107', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L713"></a><tt class="py-lineno"> 713</tt>  <tt class="py-line"> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_range"></a><div id="get_range-def"><a name="L715"></a><tt class="py-lineno"> 715</tt> <a class="py-toggle" href="#" id="get_range-toggle" onclick="return toggle('get_range');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_range">get_range</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_range-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_range-expanded"><a name="L716"></a><tt class="py-lineno"> 716</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the minimum and maximum base offsets in </tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt>  <tt class="py-line"><tt class="py-docstring">    the current axis. The base offset property of the grid will therefore be </tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt>  <tt class="py-line"><tt class="py-docstring">    within these two values. This is basically a shortcut to the grid.min </tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt>  <tt class="py-line"><tt class="py-docstring">    and grid.max where only values for the currently selected grid axis are </tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt>  <tt class="py-line"><tt class="py-docstring">    returned. </tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt>  <tt class="py-line"><tt class="py-docstring">    min </tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt>  <tt class="py-line"><tt class="py-docstring">    The minimum value in the current grid axis. </tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt>  <tt class="py-line"><tt class="py-docstring">    max </tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt>  <tt class="py-line"><tt class="py-docstring">    The maximum value in the current grid axis. </tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-108', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.range"</tt><tt class="py-op">)</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-109', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-110', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L739"></a><tt class="py-lineno"> 739</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_scale"></a><div id="get_scale-def"><a name="L740"></a><tt class="py-lineno"> 740</tt> <a class="py-toggle" href="#" id="get_scale-toggle" onclick="return toggle('get_scale');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_scale">get_scale</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_scale-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_scale-expanded"><a name="L741"></a><tt class="py-lineno"> 741</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt>  <tt class="py-line"><tt class="py-docstring">    Returns the scale values used to colour the grid and define the number </tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt>  <tt class="py-line"><tt class="py-docstring">    of contours displayed. Three values are returned, being the minimum </tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt>  <tt class="py-line"><tt class="py-docstring">    scale, the maximum scale, and the increments used to draw the contours. </tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt>  <tt class="py-line"><tt class="py-docstring">    min </tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt>  <tt class="py-line"><tt class="py-docstring">    The minimum scale value. </tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt>  <tt class="py-line"><tt class="py-docstring">    max </tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt>  <tt class="py-line"><tt class="py-docstring">    The maximum scale value. </tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt>  <tt class="py-line"><tt class="py-docstring">    inc </tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt>  <tt class="py-line"><tt class="py-docstring">    The increment size used to draw contours. </tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-111', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.scale"</tt><tt class="py-op">)</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-112', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-113', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L765"></a><tt class="py-lineno"> 765</tt>  <tt class="py-line"> </tt>
<a name="set_scale"></a><div id="set_scale-def"><a name="L766"></a><tt class="py-lineno"> 766</tt> <a class="py-toggle" href="#" id="set_scale-toggle" onclick="return toggle('set_scale');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_scale">set_scale</a><tt class="py-op">(</tt><tt class="py-param">min</tt><tt class="py-op">,</tt> <tt class="py-param">max</tt><tt class="py-op">,</tt> <tt class="py-param">inc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_scale-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_scale-expanded"><a name="L767"></a><tt class="py-lineno"> 767</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the scale range values used to colour the grid and define the </tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt>  <tt class="py-line"><tt class="py-docstring">    number of contours displayed. </tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt>  <tt class="py-line"><tt class="py-docstring">    min </tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt>  <tt class="py-line"><tt class="py-docstring">    The minimum scale value. </tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt>  <tt class="py-line"><tt class="py-docstring">    max </tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt>  <tt class="py-line"><tt class="py-docstring">    The maximum scale value. </tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt>  <tt class="py-line"><tt class="py-docstring">    inc </tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt>  <tt class="py-line"><tt class="py-docstring">    The increment size used to draw contours.</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-114', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-115', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.scale"</tt><tt class="py-op">,</tt>  </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt>  <tt class="py-line">                                                  <tt class="py-name">min</tt><tt class="py-op">,</tt> <tt class="py-name">max</tt><tt class="py-op">,</tt> <tt class="py-name">inc</tt><tt class="py-op">)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-116', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L788"></a><tt class="py-lineno"> 788</tt>  <tt class="py-line"> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_size"></a><div id="get_size-def"><a name="L790"></a><tt class="py-lineno"> 790</tt> <a class="py-toggle" href="#" id="get_size-toggle" onclick="return toggle('get_size');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_size">get_size</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_size-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_size-expanded"><a name="L791"></a><tt class="py-lineno"> 791</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the number of cells within the current analysis grid, for each </tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt>  <tt class="py-line"><tt class="py-docstring">    of its axes. Three integer values are returned, being the x, y and z </tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt>  <tt class="py-line"><tt class="py-docstring">    grid cell values. If the z value returns as 0, this means that the </tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt>  <tt class="py-line"><tt class="py-docstring">    current analysis grid is not configured as a 3D analysis grid. </tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt>  <tt class="py-line"><tt class="py-docstring">    ix, jy, kz </tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt>  <tt class="py-line"><tt class="py-docstring">    The number of grid cells in each of the X, Y and Z axis directions. </tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-117', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.size"</tt><tt class="py-op">)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-118', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-119', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L810"></a><tt class="py-lineno"> 810</tt>  <tt class="py-line"> </tt>
<a name="get_size"></a><div id="get_size-def"><a name="L811"></a><tt class="py-lineno"> 811</tt> <a class="py-toggle" href="#" id="get_size-toggle" onclick="return toggle('get_size');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_size">get_size</a><tt class="py-op">(</tt><tt class="py-param">grid_cells</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_size-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_size-expanded"><a name="L812"></a><tt class="py-lineno"> 812</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the number of cells to use with the current analysis grid, for each </tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt>  <tt class="py-line"><tt class="py-docstring">    of its axes. </tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt>  <tt class="py-line"><tt class="py-docstring">    grid_cells </tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt>  <tt class="py-line"><tt class="py-docstring">    A list of three values that represent that define the number of grid </tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt>  <tt class="py-line"><tt class="py-docstring">    cells to create in each of the X, Y and Z axis directions of the </tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt>  <tt class="py-line"><tt class="py-docstring">    analysis grid. If Z axis is not specified, the analysis grid becomes a </tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt>  <tt class="py-line"><tt class="py-docstring">    2D analysis grid.</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-120', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-121', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.size"</tt><tt class="py-op">,</tt>  </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt>  <tt class="py-line">                                                  <tt class="py-name">grid_cells</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt>  <tt class="py-line">                                                  <tt class="py-name">grid_cells</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt>  <tt class="py-line">                                                  <tt class="py-name">grid_cells</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-122', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L832"></a><tt class="py-lineno"> 832</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_state"></a><div id="get_state-def"><a name="L833"></a><tt class="py-lineno"> 833</tt> <a class="py-toggle" href="#" id="get_state-toggle" onclick="return toggle('get_state');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_state">get_state</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_state-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_state-expanded"><a name="L834"></a><tt class="py-lineno"> 834</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the state of the specified grid cell. The possible values </tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt>  <tt class="py-line"><tt class="py-docstring">    returned correspond with the following table. </tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt>  <tt class="py-line"><tt class="py-docstring">    axis. </tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt>  <tt class="py-line"><tt class="py-docstring">    state </tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value representing the state of the specified cell, according </tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt>  <tt class="py-line"><tt class="py-docstring">    to the following Grid Cell State table </tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Cell State Codes Value Description </tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt>  <tt class="py-line"><tt class="py-docstring">    1 Visible and selected. </tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt>  <tt class="py-line"><tt class="py-docstring">    0 Visible but not selected. </tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt>  <tt class="py-line"><tt class="py-docstring">    -99 Disabled. </tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt>  <tt class="py-line"><tt class="py-docstring">    -100 Hidden. </tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt>  <tt class="py-line"><tt class="py-docstring">    -100 Hidden and selected. </tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-123', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-124', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.state"</tt><tt class="py-op">,</tt>  </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt>  <tt class="py-line">                                                  <tt id="link-125" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-125', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt>  <tt class="py-line">                                                  <tt id="link-126" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-126', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-127', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-128', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-129', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L870"></a><tt class="py-lineno"> 870</tt>  <tt class="py-line"> </tt>
<a name="set_state"></a><div id="set_state-def"><a name="L871"></a><tt class="py-lineno"> 871</tt> <a class="py-toggle" href="#" id="set_state-toggle" onclick="return toggle('set_state');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_state">set_state</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_state-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_state-expanded"><a name="L872"></a><tt class="py-lineno"> 872</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the state of the specified grid cell. The possible values returned </tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt>  <tt class="py-line"><tt class="py-docstring">    correspond with the following table. </tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt>  <tt class="py-line"><tt class="py-docstring">    axis. </tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt>  <tt class="py-line"><tt class="py-docstring">    state </tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter is an integer value that controls how the specified cell </tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt>  <tt class="py-line"><tt class="py-docstring">    is to be acted upon and displayed, according to the following Grid Cell </tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt>  <tt class="py-line"><tt class="py-docstring">    State table </tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Cell State Codes Value Description </tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt>  <tt class="py-line"><tt class="py-docstring">    1 Visible and selected. </tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt>  <tt class="py-line"><tt class="py-docstring">    0 Visible but not selected. </tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt>  <tt class="py-line"><tt class="py-docstring">    -99 Disabled. </tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt>  <tt class="py-line"><tt class="py-docstring">    -100 Hidden. </tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt>  <tt class="py-line"><tt class="py-docstring">    -100 Hidden and selected. </tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-130', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-131', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.state"</tt><tt class="py-op">,</tt>  </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt>  <tt class="py-line">                                                  <tt id="link-132" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-132', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt>  <tt class="py-line">                                                  <tt id="link-133" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-133', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt>  </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt>  <tt class="py-line">                                                  <tt id="link-134" class="py-name"><a title="py2ecotect.obj._object._Object.state" class="py-name" href="#" onclick="return doclink('link-134', 'state', 'link-73');">state</a></tt><tt class="py-op">)</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-135', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L906"></a><tt class="py-lineno"> 906</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_title"></a><div id="get_title-def"><a name="L907"></a><tt class="py-lineno"> 907</tt> <a class="py-toggle" href="#" id="get_title-toggle" onclick="return toggle('get_title');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_title">get_title</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_title-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_title-expanded"><a name="L908"></a><tt class="py-lineno"> 908</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the title of the current analysis grid. </tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt>  <tt class="py-line"><tt class="py-docstring">    title </tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt>  <tt class="py-line"><tt class="py-docstring">    A text string up to 64 characters in length. </tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-136', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.title"</tt><tt class="py-op">)</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-137', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-138', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L924"></a><tt class="py-lineno"> 924</tt>  <tt class="py-line"> </tt>
<a name="set_title"></a><div id="set_title-def"><a name="L925"></a><tt class="py-lineno"> 925</tt> <a class="py-toggle" href="#" id="set_title-toggle" onclick="return toggle('set_title');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_title">set_title</a><tt class="py-op">(</tt><tt class="py-param">title</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_title-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_title-expanded"><a name="L926"></a><tt class="py-lineno"> 926</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the title of the current analysis grid. </tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt>  <tt class="py-line"><tt class="py-docstring">    title </tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt>  <tt class="py-line"><tt class="py-docstring">    A text string up to 64 characters in length containing the new title.</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-139', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-140', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.title"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-141', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt>  <tt class="py-line">         </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">locals</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L941"></a><tt class="py-lineno"> 941</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_units"></a><div id="get_units-def"><a name="L942"></a><tt class="py-lineno"> 942</tt> <a class="py-toggle" href="#" id="get_units-toggle" onclick="return toggle('get_units');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_units">get_units</a><tt class="py-op">(</tt><tt class="py-param">index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_units-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_units-expanded"><a name="L943"></a><tt class="py-lineno"> 943</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the units of measurement used for the values stored in the </tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt>  <tt class="py-line"><tt class="py-docstring">    analysis grid, such as Lux or W/m^2. </tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt>  <tt class="py-line"><tt class="py-docstring">    [index] </tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt>  <tt class="py-line"><tt class="py-docstring">    Each grid cell can store up to 5 different values and units of </tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt>  <tt class="py-line"><tt class="py-docstring">    measurement. This optional parameter specifies which slot to retrieve </tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt>  <tt class="py-line"><tt class="py-docstring">    the units for and can be an integer in the range 0 to 4. If not </tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt>  <tt class="py-line"><tt class="py-docstring">    specified, the currently selected index is used by default. </tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt>  <tt class="py-line"><tt class="py-docstring">    units </tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the units name of the nominated slot.</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-142" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-142', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-143', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.units"</tt><tt class="py-op">,</tt> <tt id="link-144" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-144', 'index', 'link-39');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-145', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-146', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-147', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L967"></a><tt class="py-lineno"> 967</tt>  <tt class="py-line"> </tt>
<a name="set_units"></a><div id="set_units-def"><a name="L968"></a><tt class="py-lineno"> 968</tt> <a class="py-toggle" href="#" id="set_units-toggle" onclick="return toggle('set_units');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_units">set_units</a><tt class="py-op">(</tt><tt class="py-param">units</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_units-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_units-expanded"><a name="L969"></a><tt class="py-lineno"> 969</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the units of measurement used for the values stored in the analysis </tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt>  <tt class="py-line"><tt class="py-docstring">    grid. </tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt>  <tt class="py-line"><tt class="py-docstring">    Each grid cell can store up to 5 different values and units of </tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt>  <tt class="py-line"><tt class="py-docstring">    measurement. The optional [index] parameter specifies which slot to </tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt>  <tt class="py-line"><tt class="py-docstring">    change the units for, and can be an integer in the range 0 to 4. If the </tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt>  <tt class="py-line"><tt class="py-docstring">    [index] parameter is not specified, the currently displayed index is </tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt>  <tt class="py-line"><tt class="py-docstring">    used by default. </tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt>  <tt class="py-line"><tt class="py-docstring">    units </tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt>  <tt class="py-line"><tt class="py-docstring">    Specifies what units of measurement to use, and can be a short string </tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt>  <tt class="py-line"><tt class="py-docstring">    such as Lux or W/m^2. </tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-148', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-149', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.units"</tt><tt class="py-op">,</tt> <tt id="link-150" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-150', 'index', 'link-39');">index</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt>  <tt class="py-line">                                                 <tt id="link-151" class="py-name" targets="Variable py2ecotect.doc.rays.Rays.units=py2ecotect.doc.rays.Rays-class.html#units"><a title="py2ecotect.doc.rays.Rays.units" class="py-name" href="#" onclick="return doclink('link-151', 'units', 'link-151');">units</a></tt><tt class="py-op">)</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-152', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L992"></a><tt class="py-lineno"> 992</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_vector"></a><div id="get_vector-def"><a name="L993"></a><tt class="py-lineno"> 993</tt> <a class="py-toggle" href="#" id="get_vector-toggle" onclick="return toggle('get_vector');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_vector">get_vector</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_vector-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_vector-expanded"><a name="L994"></a><tt class="py-lineno"> 994</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the vector value stored in the specified grid cell. Three </tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt>  <tt class="py-line"><tt class="py-docstring">    values are returned, being the x y and z components of the vector value. </tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt>  <tt class="py-line"><tt class="py-docstring">    grid axis. </tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt>  <tt class="py-line"><tt class="py-docstring">    dx, dy, dz </tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt>  <tt class="py-line"><tt class="py-docstring">    A vector value representing the offset distance in each of the X, Y and </tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt>  <tt class="py-line"><tt class="py-docstring">    Z axis, given in model coordinates. </tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-153', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-154', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.vector"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt>  <tt class="py-line">                                                  <tt id="link-155" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-155', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-156" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-156', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-157', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-158', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-159', '_convert_str_to_list', 'link-28');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1020"></a><tt class="py-lineno">1020</tt>  <tt class="py-line"> </tt>
<a name="set_vector"></a><div id="set_vector-def"><a name="L1021"></a><tt class="py-lineno">1021</tt> <a class="py-toggle" href="#" id="set_vector-toggle" onclick="return toggle('set_vector');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#set_vector">set_vector</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">offset_distance</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_vector-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_vector-expanded"><a name="L1022"></a><tt class="py-lineno">1022</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the vector value stored in the specified grid cell. </tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt>  <tt class="py-line"><tt class="py-docstring">    grid axis. </tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt>  <tt class="py-line"><tt class="py-docstring">    offset_distance </tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt>  <tt class="py-line"><tt class="py-docstring">    A list of three values that represent the vector value representing the </tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt>  <tt class="py-line"><tt class="py-docstring">    offset distance in each of the X, Y and Z axis, given in model </tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt>  <tt class="py-line"><tt class="py-docstring">    coordinates.</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-160', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-161', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.grid.vector"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt>  <tt class="py-line">                                                  <tt id="link-162" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-162', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-163" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-163', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt>  </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt>  <tt class="py-line">                                                 <tt class="py-name">offset_distance</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt>  <tt class="py-line">                                                 <tt class="py-name">offset_distance</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt>  <tt class="py-line">                                                 <tt class="py-name">offset_distance</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-164', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1047"></a><tt class="py-lineno">1047</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_zone"></a><div id="get_zone-def"><a name="L1048"></a><tt class="py-lineno">1048</tt> <a class="py-toggle" href="#" id="get_zone-toggle" onclick="return toggle('get_zone');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.grid-module.html#get_zone">get_zone</a><tt class="py-op">(</tt><tt class="py-param">position</tt><tt class="py-op">,</tt> <tt class="py-param">axis</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">draw</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_zone-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_zone-expanded"><a name="L1049"></a><tt class="py-lineno">1049</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt>  <tt class="py-line"><tt class="py-docstring">    Attempts to determine the zone within which the grid cell resides. This </tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt>  <tt class="py-line"><tt class="py-docstring">    is achieved by drawing a test ray in the direction specified by the </tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt>  <tt class="py-line"><tt class="py-docstring">    given axis. The first object hit by this ray gives the zone within which </tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt>  <tt class="py-line"><tt class="py-docstring">    this specified grid cell is located. If an axis value of 0 is used, only </tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt>  <tt class="py-line"><tt class="py-docstring">    FLOOR objects within each zone are checked - this is a very quick </tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt>  <tt class="py-line"><tt class="py-docstring">    calculation and is usualy the most appropriate axis. </tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt>  <tt class="py-line"><tt class="py-docstring">    position </tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt>  <tt class="py-line"><tt class="py-docstring">    A list of two values that represent the horizontal and vertical position </tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt>  <tt class="py-line"><tt class="py-docstring">    of the cell within the grid where the value is to be stored. Each must </tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt>  <tt class="py-line"><tt class="py-docstring">    be an integer between 0 and the current grid size - 1 in the relevant </tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt>  <tt class="py-line"><tt class="py-docstring">    grid axis. </tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt>  <tt class="py-line"><tt class="py-docstring">    [axis] </tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt>  <tt class="py-line"><tt class="py-docstring">    Specifies the axis about which to trace the test ray, according to the </tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt>  <tt class="py-line"><tt class="py-docstring">    following Grid Axis table. If not specified, the XY axis is used and </tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt>  <tt class="py-line"><tt class="py-docstring">    only FLOOR objects checked. </tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt>  <tt class="py-line"><tt class="py-docstring">    [draw] </tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter determines if the test ray should be drawn in </tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt>  <tt class="py-line"><tt class="py-docstring">    the 3D EDITOR page or not. This is a boolean value where 1 or true </tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt>  <tt class="py-line"><tt class="py-docstring">    represents the affirmative and 0 or false the negative. If not specified, </tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt>  <tt class="py-line"><tt class="py-docstring">    the default setting is not to draw each test ray. </tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt>  <tt class="py-line"><tt class="py-docstring">    zone </tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt>  <tt class="py-line"><tt class="py-docstring">    The zero-based index of the zone within which the specified grid cell </tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt>  <tt class="py-line"><tt class="py-docstring">    is most likely located. </tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt>  <tt class="py-line"><tt class="py-docstring">    Grid Axis </tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt>  <tt class="py-line"><tt class="py-docstring">    Value Axis </tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt>  <tt class="py-line"><tt class="py-docstring">    0 XY Axis </tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt>  <tt class="py-line"><tt class="py-docstring">    1 YZ Axis </tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt>  <tt class="py-line"><tt class="py-docstring">    2 XZ Axis </tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-165', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-166', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.grid.zone"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt>  <tt class="py-line">                                                  <tt id="link-167" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-167', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-168" class="py-name"><a title="py2ecotect.obj._node.Node.position" class="py-name" href="#" onclick="return doclink('link-168', 'position', 'link-37');">position</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt>  </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt>  <tt class="py-line">                                                  <tt class="py-name">axis</tt><tt class="py-op">,</tt> <tt id="link-169" class="py-name" targets="Method py2ecotect.app.graph.Graph.draw()=py2ecotect.app.graph.Graph-class.html#draw,Method py2ecotect.doc.ray.Ray.draw()=py2ecotect.doc.ray.Ray-class.html#draw"><a title="py2ecotect.app.graph.Graph.draw
py2ecotect.doc.ray.Ray.draw" class="py-name" href="#" onclick="return doclink('link-169', 'draw', 'link-169');">draw</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-170', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-171', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-172', '_convert_str_to_type', 'link-31');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1099"></a><tt class="py-lineno">1099</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:51 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
